Skip to main content

OSS Index

OSSIndex

An advisor that uses Sonatype's OSS Index to determine vulnerabilities in dependencies.

Description​

A wrapper for Sonatype's OSS Index security vulnerability data.

Configuration​

Example​

Use the following syntax to configure this plugin globally as part of config.yml:

ort:
  advisor:
    advisors:
      OSSIndex:
        options:
          serverUrl: "https://api.guide.sonatype.com/"
          username: <OPTIONAL_STRING>
        secrets:
          token: <OPTIONAL_SECRET>

Options​

serverUrl​

STRING Default

The base URL of the OSS Index REST API.

username​

STRING

The optional username is null when using Sonatype Guide authentication, or the username when using OSS Index authentication.

token​

SECRET Required

The personal access token when using Sonatype Guide authentication, or the password when using OSS Index authentication.